Grafik Collection 1

home *** CD-ROM | disk | FTP | other *** search

/ Grafik Collection 1 / Grafik Collection 1.iso / hamlabplus_demo / documentation / cmd-ref.doc < prev next >

Wrap

Text File | 1992-08-09 | 39.0 KB | 1,527 lines

HAMLAB PLUS 2.0.8 AREXX / CONFIG FILE COMMAND REFERENCE (c) Copyright 1992 J. E. Hanway. All rights reserved. IN THIS DOCUMENT: BACKGROUND AREXX SYNTAX CONFIG FILE SYNTAX COMMAND LIST COMMAND DESCRIPTIONS HAMLAB PLUS ATTRIBUTES BACKGROUND HAMLAB PLUS uses the standard AmigaDOS command syntax for both AREXX commands and config file commands. A good description of AmigaDOS command conventions can be found in Chapter 8 of "Using the System Software," the AmigaOS Release 2 User's manual. All commands are valid in AREXX programs. A subset are also valid in config files. Those are noted by one or more of the following special symbols after the command name: * means that the command is valid in a config file S means the command will be included in a file generated by the "Save Config" operation A means the command will be included in a file generated by the "Save All" operation All commands and keywords are insensitive to upper/lower case. String arguments should be enclosed in double quotes and may include spaces and the following escape sequences: \n new line \r carriage return \t horizontal tab \a bell \\ backslash \nnn nnn is three octal digits representing the character code AREXX SYNTAX In order to pass a command to HAMLAB PLUS from an AREXX program, it must be distinguished from a built-in AREXX command, usually by enclosing it in single quotes to make it a string. For example, to display the message "Hello, world!" in an AREXX program, the actual line in the program could look like: 'MESSAGE "Hello, world!"' The external single quotes are interpreted by AREXX, and the internal double quotes are processed by HAMLAB PLUS. Of course, it is probably more typical to build complex commands using AREXX's string operators. For example: 'MESSAGE' '"Current value of foo,bar is' foo||','||bar '"' CONFIG FILE SYNTAX Although config files share some of the same commands as AREXX programs, they are NOT AREXX programs. Although this means that you can't use AREXX program statements and variables in your config files, it does mean that config files will work on all systems, whether AREXX is present or not. Commands in config files should not be enclosed in extra quotes like AREXX programs. Comment lines may be included in config files by starting the line with a '#' character. Note that HamLab 1.x config files cannot be used by HAMLAB PLUS. COMMAND LIST ASKFIRST *A BEEP *A BITPLANES *SA CACHE12BIT *A CACHE24BIT *A CLEAR CLEARCONFIG *A CLOSE COMPATIBILITY *A CURVE * CURVEPOINT * DISPLAY DITHER *SA DITHER2 *SA EXPORT FILTERPATH *A FIXHAM *A GAMMA *SA GETATTR INPUTCROP *S LOADCONFIG * LOADCURVES *A LOADPALETTE *A LOCKBACKGROUND *SA LOCKGUI MESSAGE * MODULE *A NOP * ONESTEP *SA OPEN OUTPUTCROP *S PALETTEMODE *SA PAN PIPEDEV *A QUIT REQUESTFILE REQUESTNOTIFY REQUESTNUMBER REQUESTRESPONSE REQUESTSTRING RESOLUTION *SA REVERT REXXCONSOLE *A SAVE SAVEAS SAVECONFIG SAVECURVES SAVEMODE *SA SAVEPALETTE SCALE *SA SETCURVE *SA SETREQ *A TEMPPATH *A UNLOCKGUI WINDOW *A ASKFIRST *A Format: ASKFIRST [ON=TRUE=YES | OFF=FALSE=NO] Template: ON=TRUE=YES/S,OFF=FALSE=NO/S Purpose: Turns "are you sure" requesters on or off. Description: This command controls whether requesters are displayed whenever an open or clear operation will cause unsaved work to be lost. Example: ASKFIRST NO BEEP *A Format: BEEP [ON=TRUE=YES | OFF=FALSE=NO] Template: ON=TRUE=YES/S,OFF=FALSE=NO/S Purpose: Turns beeping on or off. Description: This command controls the "Beep after long functions" setting, which causes a beep and screen flash after any display, save, or export function. Example: BEEP YES BITPLANES *SA Format: BITPLANES [1 | 2 | 3 | 4 | 5 | HALFBRITE | HAM] Template: 1/S,2/S,3/S,4/S,5/S,HALFBRITE/S,HAM/S Purpose: Sets the number and type of bitplanes for the output. Description: This command sets the number of bitplanes to display and save. Normal modes allow 1-5 bit planes (1-4 in hires). In addition, the special HAM and HALFBRITE keywords (available only in lores) select those special 6 bit plane modes. Examples: BITPLANES 4 [4 bit planes] BITPLANES HAM [HAM mode (implies 6 bit planes)] CACHE12BIT *A Format: CACHE12BIT [MEM <memsize>] [DISK <disksize>] Template: MEM/N/K,DISK/N/K Purpose: Sets the size(s) of the 12 bit caches. Description: This command sets the maximum memory and/or disk size of the 12-bit cache. The sizes are specified in bytes. You may use "-1" to indicate a very large cache. (This is quite useful for a RAM cache since it tells HAMLAB PLUS to use as much RAM as necessary. If that much RAM is not available, HL+ will automatically switch to a disk cache, if enabled.) Specifying a zero will disable either a ram or disk cache. For the 12-bit cache, 2 bytes are required for each pixel. If the cache is already in use, the new settings will not take effect until other changes require the cache to be discarded. Example: CACHE12BIT MEM -1 DISK 0 [max memory cache, no disk] CACHE24BIT *A Format: CACHE24BIT [MEM <memsize>] [DISK <disksize>] Template: MEM/N/K,DISK/N/K Purpose: Sets the size(s) of the 24 bit caches. Description: This command sets the maximum memory and/or disk size of the 24-bit cache. The sizes are specified in bytes. You may use "-1" to indicate a very large cache. (This is quite useful for a RAM cache since it tells HAMLAB PLUS to use as much RAM as necessary. If that much RAM is not available, HL+ will automatically switch to a disk cache, if enabled.) Specifying a zero will disable either a ram or disk cache. For the 24-bit cache, 3 bytes are required for each pixel. If the cache is already in use, the new settings will not take effect until other changes require the cache to be discarded. Example: CACHE24BIT MEM -1 DISK 10000000 [max mem cache, 10 megs disk] CLEAR Format: CLEAR [FORCE] Template: FORCE/S Purpose: Clears the current image and all related memory and disk caches. Description: Unloads the current image from memory, and frees any temporary memory or disk space used by the image. The FORCE keyword suppresses the confirmation requester. Examples: CLEAR [displays requester] CLEAR FORCE [no requester] CLEARCONFIG *A Format: CLEARCONFIG Template: , Purpose: Clears the lists of known input filter and exporter modules. Description: This command is used to clear out the list of know input filter and exporter modules so that a new set can be loaded. The "Save All" command saves a CLEARCONFIG command at the beginning of a config file. Example: CLEARCONFIG CLOSE Format: CLOSE [FORCE] Template: , Purpose: Clears the current image and all related memory and disk caches. Description: CLOSE and CLEAR perform exactly the same function. Examples: CLOSE [displays requester] CLOSE FORCE [no requester] COMPATIBILITY *A Format: COMPATIBILITY [<mask>] Template: /N/K Purpose: Sets internal compatibility switches. This command allows certain internal settings of HAMLAB PLUS to be changed. It takes a single argument, which is a 32-bit mask (32 separate binary flags.) The following bits are defined: Bit Value Meaning 0 1 Write IFF palettes with RGB values like 00, 10, 20, ... instead of 00, 11, 22, ... ff. The latter method is correct, but some programs, especially older ones, may not handle those color values correctly. 1 2 Use Release 2 functions to set pixels in the display rather than writing to the display directly. 2-31 Reserved for future use. (Do not set them.) To turn bits on, add their values together and use the result for the mask. There is no equivalent of this function in the user interface. It must be added to the config file by editing it manually, or by entering it in the AREXX console window. Example: COMPATIBILITY 3 [Sets switches 0 and 1] CURVE * Format: CURVE [CONTRAST <delta>] [BRIGHTNESS <delta>] [MONOTONIC] [SMOOTH] [NEGATE] [INIT] [UPDATE] Template: CONTRAST/N/K,BRIGHTNESS/N/K,MONOTONIC/S,SMOOTH/S,NEGATE/S, INIT/S,UPDATE/S Purpose: Applies operations to the active color response curves. Description: This command performs one of several modification functions on the active color response curves. BRIGHTNESS and DELTA correspond to the similar user interface functions. Both take a signed numeric argument which corresponds to the step size to be used. MONOTONIC, SMOOTH, NEGATE, and INIT all correspond to user interface functions. UPDATE causes the visual display of the curve to be updated. This is not necessary after any of the other functions in this command, but is required after one or more CURVEPOINT commands. Multiple operations in the same command should be avoided, since the order in which they are applied is not defined. Examples: CURVE CONTRAST +10 [increase contrast] CURVE BRIGHTNESS -10 [decrease brightness] CURVE MONOTONIC CURVE SMOOTH CURVE NEGATE CURVE INIT CURVE UPDATE [redisplay curves] CURVEPOINT * Format: CURVEPOINT [IN] <inputval> [OUT] <outputval> Template: IN/N/K,OUT/N/K Purpose: Sets the value of a point on the active color response curves. Description: This command makes it possible to change color response curves on a point-by-point basis. A point is specified by its input value (0-255) and an output value (0-16383). Note the different ranges. The input value is always an eight bit value (0 to 255), while the output value uses a wider scale with 16383 as the maximum value. To scale an eight bit value up to this range, use: outval = eightbitval * 16383 / 255 Or for a quick and dirty approach: outval = eightbitval * 64 The point will be entered into all active curves. (Use SETCURVE to set the active curves.) NOTE: This command does not update the visual display of the color curves after entering the point. The CURVE UPDATE command must be used after all points have been entered. Examples: CURVEPOINT 0 0 [one end] CURVEPOINT 128 8192 [the middle] CURVEPOINT 255 16363 [and the other end] DISPLAY Format: DISPLAY Template: , Purpose: Displays the current image. Description: If an image is open, DISPLAY opens a screen and renders the image into it. Example: DISPLAY DITHER *SA Format: DITHER [NONE | FLOYD | JARVIS | STUCKI | ORDERED | RANDOM | SPIRAL] Template: NONE/S,FLOYD/S,JARVIS/S,STUCKI/S,ORDERED/S,RANDOM/S,SPIRAL/S Purpose: Sets the type of dithering used to reduce from 24 bits to 12 bits. Description: This command controls the "24->12 dither" setting. Example: DITHER FLOYD DITHER2 *SA Format: DITHER2 [NONE | FLOYD | JARVIS | STUCKI] Template: NONE/S,FLOYD/S,JARVIS/S,STUCKI/S Purpose: Sets the type of dithering used to render to the display. Description: This command controls the "12->display dither" setting. Example: DITHER2 NONE EXPORT Format: EXPORT [EXPORTER <name>] [NAME <filename>] [ARGS <args>] Template: EXPORTER/K,NAME/K,ARGS/K Purpose: Processes the current image through an exporter module. Description: Without the NAME and ARGS arguments, the EXPORT command brings up the list of available exporters and allows one to be chosen, just as if the EXPORT button were selected by the user. Alternatively, the exporter program and its arguments may be specified as part of the command. This will bypass the list display and run a specific exporter directly. The proper name and args for an exporter must be obtained first. (See the filter/exporter reference for information on specific exporters.) The NAME keyword allows the name of the file to be exported to be specified. This information is passed on to the exporter program, and may be used or ignored depending on the exporter. Typically, if you specify a file name, the exporter will not display a file requester. Examples: EXPORT NAME foo.out [user selects from list] EXPORT NAME foo.bw-eps EXPORTER "export_eps" ARGS "bw" [uses a specific exporter] FILTERPATH *A Format: FILTERPATH [NAME] <filterpath> Template: NAME/A Purpose: Sets the disk path to find filters and exporters. Description: This command sets the directory where HAMLAB PLUS input filter and exporter modules are stored. Example: FILTERPATH "SYS:hl-filters" FIXHAM *A Format: FIXHAM [ON=TRUE=YES | OFF=FALSE=NO] Template: ON=TRUE=YES/S,OFF=FALSE=NO/S Purpose: Turns glitchless HAM scrolling on or off. Description: This command controls the "Fix Ham Scrolling" setting, which repairs left edge glitches caused when the true left edge of a HAM picture is not visible on the display. Example: FIXHAM ON GAMMA *SA Format: GAMMA [VALUE] <gamma> [COMPENSATE | UNCOMPENSATE] Template: VALUE/N,COMPENSATE/S,UNCOMPENSATE/S Purpose: Loads a gamma value and/or applies it to the color response curves. Description: This command changes the current gamma value and/or applies it to the active color response curves. VALUE specifies the gamma value, which must be between 0.1 and 9.9 and must be written that way (two digits separated by a period). The COMPENSATE and UNCOMPENSATE keywords apply the gamma to the active color response curves. Example: GAMMA 2.2 COMPENSATE GETATTR Format: GETATTR [OBJECT] <object> STEM <stem> Template: OBJECT/A,STEM/K Purpose: Returns the contents of a HAMLAB PLUS attribute in an AREXX stem variable. Description: GETATTR obtains the values of a group of related HAMLAB PLUS attributes and copies their values into AREXX variables. The OBJECT is one of several object names that HAMLAB PLUS understands. See the end of this section for a complete list of OBJECTs and their associated attributes. The STEM keyword specifies the base name of all of the AREXX variables to be filled in by the GETATTR command. The base name may optionally be followed by a period. See the HAMLAB PLUS ATTRIBUTES section for a complete list of objects supported by the getattr command and their attributes. Example: GETATTR APPLICATION STEM APPL. [fills in APPL.NAME, etc.] INPUTCROP *S Format: INPUTCROP [WIDTH <width>] [HEIGHT <height>] [UL <x1>,<y1>] [LR <x2>,<y2>] [FULLSIZE] Template: WIDTH/N/K,HEIGHT/N/K,UL/K,LR/K,FULLSIZE/S Purpose: Sets the input cropping limits. Description: This command changes the input cropping boundaries. In one command, you may specify the boundaries by width and/or height, or by coordinates of the upper left and/or lower right corners. Coordinates are specified by two numbers separated by a comma. There should be no space between the comma and either number. The FULLSIZE keyword resets the cropping boundaries to include the full image. Specifying conflicting arguments in the same command should be avoided. Examples: INPUTCROP WIDTH 320 HEIGHT 200 [by size] INPUTCROP UL 0,0 LR 100,100 [by corners] INPUTCROP FULLSIZE [reset to full size] LOADCONFIG * Format: LOADCONFIG [FILENAME <filename>] Template: FILENAME/K Purpose: Loads settings from a configuration file. Description: This command loads a previously saved configuration file. If a path and file name is specified with the FILENAME keyword it will be used. Otherwise, a file requester will be displayed and the user's choice will be loaded. Example: LOADCONFIG FILENAME "SYS:hlconfigs/hires" LOADCURVES *A Format: LOADCURVES [FILENAME <name>] Template: FILENAME/K Purpose: Loads a set of color response curves from a HamLab curve file or an IFF CLUT chunk. Description: This command causes the active color response curves to be loaded from a file. (Either a HamLab color curve file or from the CLUT chunks of any IFF picture containing them.) If a name is specified with the FILENAME keyword, it will be used. Otherwise, a file requester will be displayed and the user's choice will be used. Example: LOADCURVES FILENAME "ram:scanner1.curve" LOADPALETTE *A Format: LOADPALETTE [FILENAME <name>] Template: FILENAME/K Purpose: Loads a fixed set of colors from an IFF palette file. Description: This command loads an IFF palette file, automatically switching to FROZEN palette mode if necessary. If a name is specified with the FILENAME keyword, it will be used. Otherwise, a file requester will be displayed and the user's choice will be used. Example: LOADPALETTE FILENAME "ram:frame1.pal" LOCKBACKGROUND *SA Format: LOCKBACKGROUND [ON=TRUE=YES | OFF=FALSE=NO] Template: ON=TRUE=YES/S,OFF=FALSE=NO/S Purpose: Sets whether the exact background color is preserved. Description: This command controls the "Lock background color" setting. Example: LOCKBACKGROUND FALSE LOCKGUI Format: LOCKGUI Template: , Purpose: Deactivates all program gadgets. Description: LOCKGUI causes the busy pointer (the watch) to be displayed in all windows. WARNING: this command can cause the HAMLAB PLUS to appear locked up. No HL+ gadgets (except buttons like OK and Cancel in requesters) will respond to any further activity until an UNLOCKGUI command is received. Executing LOCKGUI more than once has no effect -- the program is only locked once, and a single UNLOCKGUI command will always unlock it. Example: LOCKGUI MESSAGE * Format: MESSAGE [[PROMPT] <message>] [CLEAR] Template: PROMPT,CLEAR/S Purpose: Displays a message in the HAMLAB PLUS message area. Description: Writes a single line message to the three line message area in the HAMLAB PLUS base window, scrolling previous messages up, if any. The CLEAR keyword clears the message area before displaying the message. Examples: MESSAGE "Hello, world!" MESSAGE CLEAR MESSAGE CLEAR "Starting complicated process..." MODULE *A Format: MODULE OLDFILTER NAME <name> PATTERN <magic> MODULE INPUTFILTER NAME <name> PATTERN <magic> ARGS <args> MODULE EXPORTER NAME <name> DESCRIPTION <desc> ARGS <args> Template: OLDFILTER/S,INPUTFILTER/S,EXPORTER/S, NAME/A/K,MAGIC/K,DESCRIPTION/K,ARGS/K Purpose: Makes an input filter or exporter known to HAMLAB PLUS. Description: These commands, used primarily in config files, give HAMLAB PLUS information about available input filter and exporter modules. Three types of modules are possible: OLDFILTER a HamLab 1.x input filter. Described by NAME of the module and a PATTERN which must be matched in an input file for this filter to be used. INPUTFILTER a HamLab 2.x input filter. Described by NAME of the module, PATTERN to be matched, and an ARGS string to be passed to the filter. EXPORTER a HamLab 2.x exporter. Described by NAME of the module, a text DESCRIPTION used for the list presented to the user, and an ARGS string to be passed to the exporter. Examples: MODULE OLDFILTER NAME "ilbm2hl" PATTERN "FORM" MODULE INPUTFILTER NAME "ilbm_input" PATTERN "FORM" ARGS "" MODULE EXPORTER NAME "export_iff24" DESCRIPTION "24bit IFF" ARGS "" NOP * Format: NOP Template: , Purpose: Does absolutely nothing. Description: This command does absolutely nothing. Example: NOP ONESTEP *SA Format: ONESTEP [ON=TRUE=YES | OFF=FALSE=NO] Template: ON=TRUE=YES/S,OFF=FALSE=NO/S Purpose: Sets whether dithering is done in one or two steps. Description: This command controls the "One step dithering" setting. Example: ONESTEP ON OPEN Format: OPEN [FILENAME <filename>] [FORCE] Template: FILENAME/K,FORCE/S Purpose: Opens a new image. Description: Clears the current image, if any (see CLEAR), and attempts to open a new image. Returns a warning result code (5) if the file cannot be opened for any reason. The FORCE keyword suppresses the confirmation requester before clearing the current image. If a filename (including a full path) is specified with the FILENAME keyword, it will be used, otherwise, the normal file requester will be used to allow the input file name to be selected. Examples: OPEN FILENAME foo.bar FORCE [no requesters] OPEN [displays requester] OUTPUTCROP *S Format: OUTPUTCROP [WIDTH <width>] [HEIGHT <height>] [UL <x1>,<y1>] [LR <x2>,<y2>] [FULLSIZE] Template: WIDTH/N/K,HEIGHT/N/K,UL/K,LR/K,FULLSIZE/S Purpose: Sets the output cropping limits. Description: This command changes the output cropping boundaries. In one command, you may specify the boundaries by width and/or height, or by coordinates of the upper left and/or lower right corners. Coordinates are specified by two numbers separated by a comma. There should be no space between the comma and either number. The FULLSIZE keyword resets the cropping boundaries to include the full image. Specifying conflicting arguments in the same command should be avoided. Examples: OUTPUTCROP WIDTH 320 HEIGHT 200 [by size] OUTPUTCROP UL 0,0 LR 100,100 [by corners] OUTPUTCROP FULLSIZE [reset to full size] PALETTEMODE *SA Format: PALETTEMODE [NORMAL | SLICED <num> | FROZEN] Template: NORMAL/S,SLICED/K/N,FROZEN/S Purpose: Sets the type of palette used for the output. Description: This command sets the type of palette used for displaying and saving. The NORMAL and FROZEN keywords select their respective modes. The SLICED keyword selects sliced mode, and must be followed by a number indicating the number of colors to slice. Examples: PALETTEMODE NORMAL [normal palette] PALETTEMODE SLICED 7 [sliced mode, 7 colors sliced] PAN Format: PAN [X <num>] [Y <num>] [ABSOLUTE] Template: X/N,Y/N,ABSOLUTE/S Purpose: Scrolls the display to expose a different portion of the current image. Description: PAN determines what coordinates of the image are positioned in the upper left corner of the screen. Normally the upper left corner displays the upper left corner of the image (0, 0). Normally the coordinates are changed incrementally, but the ABSOLUTE keyword will cause the coordinates to be replaced, rather than added to. Either the X coordinate, the Y coordinate, or both may be changed. All panning movements are restricted to keep part of the image on screen. Thus PAN ABSOLUTE X 9999 will move to the right edge of anyo reasonably sized image. Examples: PAN X +10 [relative scroll right] PAN Y -10 [relative scroll up] PAN ABSOLUTE X 0 Y 0 [reset to upper left] PIPEDEV *A Format: PIPEDEV [NAME] <pipedevice> Template: NAME/A Purpose: Sets the device to use for pipes. Description: This command sets the device to be used whenever HAMLAB PLUS uses a DOS pipe. Currently HAMLAB PLUS only uses DOS pipes to interface to old HamLab 1.x input filters. Example: PIPEDEV "PIPE:" QUIT Format: QUIT [FORCE] Template: FORCE/S Purpose: Exits HAMLAB PLUS. Description: The FORCE keyword suppresses the requester that would be displayed before quitting with an unsaved image loaded. Examples: QUIT [may display requester] QUIT FORCE [never a requester] REQUESTFILE Format: REQUESTFILE [TITLE <title>] [PATH <path>] [FILE <file>] [PATTERN <pattern>] Template: TITLE/K,PATH/K,FILE/K,PATTERN/K Purpose: Gets input from a file requester. Description: This command displays a generic file requester. If the user selects a file name, the special variable RESULT will be filled in with the full path name. Otherwise, a warning result code will be returned. The TITLE keyword specifies a window title. The PATH, FILE, and PATTERN keywords specify initial values for the file requester. If any of these are omitted, empty strings will be used as the default. Example: REQUESTFILE TITLE "Select a file" PATH "ram:" PATTERN "#?.iff" [returns full path in RESULT] REQUESTNOTIFY Format: REQUESTNOTIFY [TITLE <title>] [PROMPT <prompt>] Template: TITLE/K,PROMPT/K Purpose: Displays an information-only requester. Description: This command displays a simple requester with a title, one line of text, and an OK button. The TITLE keyword specifies text for the requester's title bar. The PROMPT keyword specifies text displayed within the requester. Example: REQUESTNOTIFY TITLE "Notice" PROMPT "Rendering all done!" [no return value] REQUESTNUMBER Format: REQUESTNUMBER [PROMPT <prompt>] [DEFAULT <number>] Template: PROMPT/K,DEFAULT/N/K Purpose: Gets input from a number entry requester. Description: This command displays a generic number entry requester. If the user enters a number, it will be returned in the special RESULT varaible. Otherwise, a warning result will be returned. The PROMPT keyword specifies prompting text to be used in the requester's title bar. The DEFAULT keyword specifies the initial value for the number entry gadget. Example: REQUESTNUMBER PROMPT "Enter width:" DEFAULT 640 [returns number in RESULT] REQUESTRESPONSE Format: REQUESTRESPONSE [TITLE <title>] [PROMPT <prompt>] Template: TITLE/K,PROMPT/K Purpose: Gets a yes/no response from a requester. Description: This command displays a generic yes/no requester (actually, it's an OK/Cancel requester.) If the user selects OK, a normal zero result code is returned, otherwise a warning code (5) is returned. The TITLE keyword specifies text for the requester's title bar. The PROMPT keyword specifies text displayed within the requester. Example: REQUESTRESPONSE TITLE "Confirmation" PROMPT "Ok to exit?" [returns RC=0 (ok) or RC=5] REQUESTSTRING Format: REQUESTSTRING [PROMPT <prompt>] [DEFAULT <string>] Template: PROMPT/K,DEFAULT/K Purpose: Gets input from a string entry requester. Description: This command displays a generic string entry requester. If the user enters a string, it will be returned in the special RESULT variable. Otherwise, a warning result code will be returned. The PROMPT keyword specifies prompting text to be used in the requester's title bar. The DEFAULT keyword specifies the initial value for the string entry gadget. Example: REQUESTSTRING PROMPT "Enter your name:" DEFAULT "Ed" [returns string in RESULT] RESOLUTION *SA Format: RESOLUTION [LOW | HIGH] [LACE | NOLACE] Template: LOW/S,HIGH/S,LACE/S,NOLACE/S Purpose: Sets the output resolution. Description: This command sets the display resolution and/or interlace setting. Examples: RESOLUTION LOW RESOLUTION HIGH LACE REVERT Format: REVERT Template: , Purpose: Revert to previous settings. Description: This command returns all settings to those used for the last DISPLAY or SAVE operation. Example: REVERT REXXCONSOLE *A Format: REXXCONSOLE [NAME] <window> Template: NAME/A Purpose: Sets the window description to use for the REXX console window. Description: This command sets the DOS console window description to be used for the AREXX console window. See the AmigaDOS manual for the format for console window descriptions. If the AREXX console is already open, the changes will not be reflected until the console window is closed and reopened. Example: REXXCONSOLE "CON:0/0/500/100/REXX Console/CLOSE" SAVE Format: SAVE [OVERWRITE] Template: OVERWRITE/S Purpose: Saves the current image using the current path and filename. Description: The OVERWRITE keyword suppresses the confirmation requester that would be displayed before overwriting an existing file. Examples: SAVE [asks before overwriting] SAVE OVERWRITE [doesn't ask] SAVEAS Format: SAVEAS [NAME <filename>] [OVERWRITE] Template: NAME/K,OVERWRITE/S Purpose: Saves the current image using a new filename. Description: If a filename (including a full path) is specified with the NAME keyword, it will be used. Otherwise, the normal save file requester will be used to allow the user to enter the filename. The OVERWRITE keyword suppresses the confirmation requester that would be displayed before overwriting an existing file. Example: SAVEAS NAME dh0:foo.iff OVERWRITE SAVECONFIG Format: SAVECONFIG [NAME <filename>] [ALL] [OVERWRITE] Template: NAME/K,ALL/S,OVERWRITE/S Purpose: Saves current settings to a configuration file. Description: If a filename is specified with the NAME keyword, it will be used. Otherwise, a file requester will be displayed and the user's choice will be used. If the ALL keyword is specified, a full set of commands will be saved in the config file, just as if the "Save All" button were selected. Otherwise, a partial config file will be saved. Note the S and A indicated with commands in this section tell which commands are included in partial and full config files. The OVERWRITE keyword forces the new config file to overwrite any existing one with the same name. If omitted, and a file with the same name exists, a confirmation requester will be displayed. Cropping settings will only be saved in a partial config file, and only when an image is currently open. Examples: SAVECONFIG ALL [full config file] SAVECONFIG NAME "hlconfigs:hires" [partial config file] SAVECURVES Format: SAVECURVES [NAME <filename>] [OVERWRITE] Template: NAME/K,OVERWRITE/S Purpose: Saves current color response curves to a HamLab curve file. Description: If a filename is specified with the NAME keyword, it will be used. Otherwise, a file requester will be displayed and the user's choice will be used. If the OVERWRITE keyword is specified, the requester that would normally be displayed before overwriting an existing file will be suppressed. Example: SAVECURVES NAME "hlcurves:scanner-compensation" SAVEMODE *SA Format: SAVEMODE [PCHG] [SHAM] [DYNAMIC] Template: PCHG/S,SHAM/S,DYNAMIC/S Purpose: Sets the type(s) of special IFF chunks used to save "sliced" output files. Description: This command determines which combination of three IFF formats will be used to store sliced color information. At least one, and as many as all three, of the PCHG SHAM and DYNAMIC keywords must be specified. Examples: SAVEMODE PCHG [save PCHG chunks only] SAVEMODE SHAM DYNAMIC [save both SHAM and DYNAMIC chunks] SAVEPALETTE Format: SAVEPALETTE [NAME <filename>] [OVERWRITE] Template: NAME/K,OVERWRITE/S Purpose: Saves current palette colors to an IFF palette file. Description: If a filename is specified with the NAME keyword, it will be used. Otherwise, a file requester will be displayed and the user's choice will be used. If the OVERWRITE keyword is specified, the requester that would normally be displayed before overwriting an existing file will be suppressed. This command is only valid when the palette is in FROZEN mode. Using it in other situations will return an error. Example: SAVEPALETTE NAME "ram:frame1.pal" OVERWRITE SCALE *SA Format: SCALE [X <xscale>] [Y <yscale>] [PERCENT] [CONSTRAINED|UNCONSTRAINED] Template: X/N/K,Y/N/K,PERCENT/S,CONSTRAINED/S,UNCONSTRAINED/S Purpose: Sets the scaling factor(s). Description: This command changes the X and Y scaling factors used by HAMLAB PLUS. The default is to specify the scaling by the size of the resulting image, but the PERCENT keyword will cause the values to be interpreted as percentages. Note that the PERCENT keyword will apply to both X and Y if both are used in the same command. The CONSTRAINED/UNCONSTRAINED keyword changes the state of the "Constrained Scale" setting. (When turned on, changes in one dimension will cause proportional changes in the other dimension, preserving the aspect ratio.) Examples: SCALE X 320 Y 400 [result will be 320x400 pixels] SCALE X 100 PERCENT [will be 100% of original width] SCALE CONSTRAINED [turns constrained scaling on] SETCURVE *SA Format: SETCURVE [RED] [GREEN] [BLUE] [[STEPSIZE] <stepsize>] Template: RED/S,GREEN/S,BLUE/S,STEPSIZE/N Purpose: Sets the active curves and/or the curve operation step size. Description: This command sets which color response curves are "active," (affected by other curve modification commands) and sets the step size used by other curve modification commands. A curve is made active by including its keyword (RED or GREEN or BLUE). Omitting a keyword for a curve will deactivate it. The optional STEPSIZE keyword takes a single numeric argument of 1, 2, 4, or 8. Example: SETCURVE RED GREEN BLUE STEPSIZE 2 SETREQ *A Format: SETREQ INPUT|OUTPUT|CURVE|PALETTE [PATH <path>] [FILE <file>] [PATTERN <pattern>] Template: INPUT/S,OUTPUT/S,CURVE/S,PALETTE/S,PATH/K,FILE/K,PATTERN/K Purpose: Sets the initial values for a file requester. Description: This command allows the fields of HAMLAB PLUS file requesters to be configured to useful initial values. There are four controllable sets of file requester values, corresponding to various operations as follows: INPUT loading images OUTPUT saving and exporting CURVE loading and saving curves PALETTE loading and saving palettes For each set, three values may be set: PATH the initial directory name FILE the initial file name PATTERN the wild-card matching pattern (blank pattern matches everything) The PATTERN field is only supported by the Release 2 ASL file requester. For the OUTPUT requester, the FILE value is used to set the extension (i.e. ".iff" ".ham" etc.) of the filename. The rest of the name is derived from the original name. Once a user changes a value in a file requester, the changed value will replace the previous value for the next time the file requester is used. Examples: SETREQ INPUT PATH "DH0:stuff" FILE "" PATTERN "#?.(gif|jpg)" SETREQ OUTPUT PATH "DH1:mypics" FILE ".iff" PATTERN "#?.iff" TEMPPATH *A Format: TEMPPATH [NAME] <temppath> Template: NAME/A Purpose: Sets the disk path for temporary files. Description: This command sets the directory where temporary 12- and 24-bit disk cache files are created. If temporary files already exist in the old temporary directory, they will remain until other operations require them to be deleted and/or recreated. Example: TEMPPATH "T:" UNLOCKGUI Format: UNLOCKGUI Template: , Purpose: Reactivates all program gadgets. Description: Unlocks the user interface, which was previously locked by LOCKGUI. UNLOCKGUI can only unlock a lock created by the LOCKGUI command. Other locked conditions, such as during long processes, can only be unlocked by selecting the appropriate cancel gadget. Executing UNLOCKGUI when the program is not locked has no effect. Example: UNLOCKGUI WINDOW *A Format: WINDOW [NAME] [ABOUT|BASE|OUTPUT|CONFIG|COLOR] [[LEFT] <leftedge>] [[TOP] <topedge>] [OPEN | CLOSE] Template: NAME/A,LEFT/N,TOP/N,OPEN/S,CLOSE/S Purpose: Manipulates a HAMLAB PLUS window. Description: This command provides control over the five HAMLAB PLUS windows. The position of the upper left corner of the window may be specified with the LEFT and TOP keywords, and/or the window may be opened or closed with the appropriate keyword. HAMLAB PLUS windows retain their positions, even while closed, so it is possible to position a window even while it is closed -- the new position will be used whenever the window is next opened. If the position would cause the window to extend off the edge of the screen, it will be adjusted to bring the window back onto the screen. The BASE window cannot be closed using this command. (It can only be closed when exiting the program.) If the OPEN command is used on a window that is already open, it will be moved to the front. Examples: WINDOW CONFIG LEFT 100 TOP 10 [position window] WINDOW COLOR OPEN [open window] HAMLAB PLUS ATTRIBUTES The following are valid objects for the GETATTR ARexx function: APPLICATION .NAME string Name of program, i.e. "HAMLAB PLUS" .VERSION string Version of the program .SCREEN string Name of public screen in use, if any. .COMPATIBILITY number INPUT .NAME string .PATH string .PATTERN string .WIDTH number (zero if no picture loaded) .HEIGHT number (zero if no picture loaded) .DEPTH number (zero if unknown) .FORMAT string .CROP.ULX number .CROP.ULY number .CROP.WIDTH number .CROP.HEIGHT number OUTPUT .NAME string .PATH string .PATTERN string .EXTENSION string .CROP.ULX number .CROP.ULY number .WIDTH number .HEIGHT number .MODE.RESOLUTION HIGH/LOW .MODE.INTERLACE ON/OFF .MODE.ONESTEP ON/OFF .MODE.LOCKBACKGROUND ON/OFF .MODE.BITPLANES 1-5/HAM/HALFBRITE .MODE.DITHER NONE/FLOYD/JARVIS/STUCKI/ORDERED/RANDOM/SPIRAL .MODE.DITHER2 NONE/FLOYD/JARVIS/STUCKI .MODE.PALETTEMODE NORMAL/SLICED/FROZEN .MODE.SLICECOLORS number .MODE.SAVEMODE PCHG SHAM DYNAMIC SCALE .X number .Y number .XPERCENT ON/OFF .YPERCENT ON/OFF .CONSTRAINED ON/OFF DISPLAY .TOTAL.WIDTH number .TOTAL.HEIGHT number .VISIBLE.ULX number .VISIBLE.ULY number .VISIBLE.WIDTH number .VISIBLE.HEIGHT number COLOR .GAMMA n.n .STEPSIZE 1/2/4/8 .PATH string .FILE string .PATTERN string .RED 256 packed 2-byte values .GREEN 256 packed 2-byte values .BLUE 256 packed 2-byte values CONFIG .FIXHAM ON/OFF .BEEP ON/OFF .ASK ON/OFF .TEMPPATH ON/OFF .FILTERPATH ON/OFF .PIPEDEV ON/OFF .REXXCON ON/OFF .CACHE12BIT.MEM number .CACHE12BIT.DISK number .CACHE24BIT.MEM number .CACHE24BIT.DISK number